/*-
 * #%L
 * OfficeCompiler
 * %%
 * Copyright (C) 2005 - 2020 Daniel Sagenschneider
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 * #L%
 */

package net.officefloor.compile.test.officefloor;

import net.officefloor.compile.spi.office.OfficeManagedObject;
import net.officefloor.compile.spi.officefloor.DeployedOffice;
import net.officefloor.compile.spi.officefloor.OfficeFloorDeployer;
import net.officefloor.compile.spi.officefloor.OfficeFloorManagedObject;
import net.officefloor.compile.spi.officefloor.source.OfficeFloorSourceContext;
import net.officefloor.frame.internal.structure.ManagedObjectScope;
import net.officefloor.plugin.managedobject.clazz.ClassManagedObjectSource;

/**
 * Provides context for the {@link CompileOfficeFloorExtension}.
 * 
 * @author Daniel Sagenschneider
 */
public interface CompileOfficeFloorContext {

	/**
	 * Obtains the {@link OfficeFloorDeployer}.
	 * 
	 * @return {@link OfficeFloorDeployer}.
	 */
	OfficeFloorDeployer getOfficeFloorDeployer();

	/**
	 * Obtains the {@link DeployedOffice}.
	 * 
	 * @return {@link DeployedOffice}.
	 */
	DeployedOffice getDeployedOffice();

	/**
	 * Obtains the {@link OfficeFloorSourceContext}.
	 * 
	 * @return {@link OfficeFloorSourceContext}.
	 */
	OfficeFloorSourceContext getOfficeFloorSourceContext();

	/**
	 * Adds an {@link OfficeFloorManagedObject} for
	 * {@link ClassManagedObjectSource}.
	 * 
	 * @param managedObjectName
	 *            Name of the {@link OfficeManagedObject}.
	 * @param managedObjectClass
	 *            {@link Class} for the {@link ClassManagedObjectSource}.
	 * @param scope
	 *            {@link ManagedObjectScope}.
	 * @return {@link OfficeFloorManagedObject}.
	 */
	OfficeFloorManagedObject addManagedObject(String managedObjectName, Class<?> managedObjectClass,
			ManagedObjectScope scope);

}
